vacuum2.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2026 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef VACUUM2_H
#define VACUUM2_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_analog_in.h"
#include "drv_i2c_master.h"




#define VACUUM2_PRESSURE_PA_MIN     -2000
#define VACUUM2_PRESSURE_PA_MAX      2000
#define VACUUM2_PRESSURE_SENS_PA     0.001
#define VACUUM2_ADC_VOUT_MULTIPLIER  2

#define VACUUM2_NUM_CONVERSIONS      200

#define VACUUM2_ADC_RESOLUTION       0x0FFF
#define VACUUM2_VREF_3V3             3.3
#define VACUUM2_VREF_5V              5.0

#define VACUUM2_TIMEOUT_MS           2000

#define VACUUM2_SET_DEV_ADDR         0x4D
 // vacuum2_set



#define VACUUM2_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.an  = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
 // vacuum2_map // vacuum2

typedef enum
{
    VACUUM2_DRV_SEL_ADC,                
    VACUUM2_DRV_SEL_I2C                 
 
} vacuum2_drv_t;

typedef struct
{
    analog_in_t  adc;                   
    i2c_master_t i2c;                   
 
    uint8_t      slave_address;         
    float        vref;                  
    float        zero_press_offset;     
    vacuum2_drv_t drv_sel;              
 
} vacuum2_t;

typedef struct
{
    pin_name_t an;                      
    pin_name_t scl;                     
    pin_name_t sda;                     
 
    analog_in_resolution_t resolution;  
    float                  vref;        
    
    uint32_t               i2c_speed;   
    uint8_t                i2c_address; 
    
    vacuum2_drv_t drv_sel;              
 
} vacuum2_cfg_t;

typedef enum
{
    VACUUM2_OK = 0,
    VACUUM2_ERROR = -1
 
} vacuum2_return_value_t;


void vacuum2_cfg_setup ( vacuum2_cfg_t *cfg );

void vacuum2_drv_interface_sel ( vacuum2_cfg_t *cfg, vacuum2_drv_t drv_sel );

err_t vacuum2_init ( vacuum2_t *ctx, vacuum2_cfg_t *cfg );

err_t vacuum2_read_adc_raw ( vacuum2_t *ctx, uint16_t *raw_adc );

err_t vacuum2_read_adc_voltage ( vacuum2_t *ctx, float *voltage );

err_t vacuum2_set_vref ( vacuum2_t *ctx, float vref );

err_t vacuum2_read_vout ( vacuum2_t *ctx, float *vout );

err_t vacuum2_read_vout_avg ( vacuum2_t *ctx, uint16_t num_conv, float *vout_avg );

err_t vacuum2_calib_offset ( vacuum2_t *ctx );

err_t vacuum2_read_pressure ( vacuum2_t *ctx, int16_t *pressure );
 
#ifdef __cplusplus
}
#endif
#endif // VACUUM2_H
 // vacuum2
 
// ------------------------------------------------------------------------ END